

<!DOCTYPE html>
<html class="writer-html5" lang="en" data-content_root="./">
<head>
  <meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />

  <meta name="viewport" content="width=device-width, initial-scale=1.0" />
  <title>pymatgen.apps package &mdash; pymatgen 2025.6.14 documentation</title>
      <link rel="stylesheet" type="text/css" href="assets/pygments.css?v=03e43079" />
      <link rel="stylesheet" type="text/css" href="assets/css/theme.css?v=e59714d7" />
      <link rel="stylesheet" type="text/css" href="assets/css/custom.css" />

  
    <link rel="canonical" href="https://pymatgen.orgpymatgen.apps.html"/>
      <script src="assets/jquery.js?v=5d32c60e"></script>
      <script src="assets/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
      <script src="assets/documentation_options.js?v=03bec786"></script>
      <script src="assets/doctools.js?v=9bcbadda"></script>
      <script src="assets/sphinx_highlight.js?v=dc90522c"></script>
    <script src="assets/js/theme.js"></script>
    <link rel="index" title="Index" href="genindex.html" />
    <link rel="search" title="Search" href="search.html" /> 
</head>

<body class="wy-body-for-nav"> 
  <div class="wy-grid-for-nav">
    <nav data-toggle="wy-nav-shift" class="wy-nav-side">
      <div class="wy-side-scroll">
        <div class="wy-side-nav-search"  style="background: linear-gradient(0deg, rgba(23,63,162,1) 0%, rgba(0,70,192,1) 100%)" >

          
          
          <a href="index.html">
            
          </a>
<div role="search">
  <form id="rtd-search-form" class="wy-form" action="search.html" method="get">
    <input type="text" name="q" placeholder="Search docs" aria-label="Search docs" />
    <input type="hidden" name="check_keywords" value="yes" />
    <input type="hidden" name="area" value="default" />
  </form>
</div>
        </div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
              <!-- Local TOC -->
              <div class="local-toc"><ul>
<li><a class="reference internal" href="#">pymatgen.apps package</a><ul>
<li><a class="reference internal" href="#subpackages">Subpackages</a></li>
</ul>
</li>
</ul>
</div>
        </div>
      </div>
    </nav>

    <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu"  style="background: linear-gradient(0deg, rgba(23,63,162,1) 0%, rgba(0,70,192,1) 100%)" >
          <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
          <a href="index.html">pymatgen</a>
      </nav>

      <div class="wy-nav-content">
        <div class="rst-content style-external-links">
          <div role="navigation" aria-label="Page navigation">
  <ul class="wy-breadcrumbs">
      <li><a href="index.html" class="icon icon-home" aria-label="Home"></a></li>
      <li class="breadcrumb-item active">pymatgen.apps package</li>
      <li class="wy-breadcrumbs-aside">
              <a href="https://github.com/materialsproject/pymatgen/blob/master/docs_rst/pymatgen.apps.rst" class="fa fa-github"> Edit on GitHub</a>
      </li>
  </ul>
  <hr/>
</div>
          <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
           <div itemprop="articleBody">
             
  <section id="module-pymatgen.apps">
<span id="pymatgen-apps-package"></span><h1>pymatgen.apps package<a class="headerlink" href="#module-pymatgen.apps" title="Link to this heading"></a></h1>
<p>This package is an overarching package for subpackages for specific materials
applications.</p>
<section id="subpackages">
<h2>Subpackages<a class="headerlink" href="#subpackages" title="Link to this heading"></a></h2>
<div class="toctree-wrapper compound">
<ul>
<li class="toctree-l1"><a class="reference internal" href="pymatgen.apps.battery.html">pymatgen.apps.battery package</a><ul>
<li class="toctree-l2"><a class="reference internal" href="pymatgen.apps.battery.html#submodules">Submodules</a></li>
<li class="toctree-l2"><a class="reference internal" href="pymatgen.apps.battery.html#module-pymatgen.apps.battery.analyzer">pymatgen.apps.battery.analyzer module</a><ul>
<li class="toctree-l3"><a class="reference internal" href="pymatgen.apps.battery.html#pymatgen.apps.battery.analyzer.BatteryAnalyzer"><code class="docutils literal notranslate"><span class="pre">BatteryAnalyzer</span></code></a><ul>
<li class="toctree-l4"><a class="reference internal" href="pymatgen.apps.battery.html#pymatgen.apps.battery.analyzer.BatteryAnalyzer.get_max_capgrav"><code class="docutils literal notranslate"><span class="pre">BatteryAnalyzer.get_max_capgrav()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="pymatgen.apps.battery.html#pymatgen.apps.battery.analyzer.BatteryAnalyzer.get_max_capvol"><code class="docutils literal notranslate"><span class="pre">BatteryAnalyzer.get_max_capvol()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="pymatgen.apps.battery.html#pymatgen.apps.battery.analyzer.BatteryAnalyzer.get_removals_int_oxid"><code class="docutils literal notranslate"><span class="pre">BatteryAnalyzer.get_removals_int_oxid()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="pymatgen.apps.battery.html#pymatgen.apps.battery.analyzer.BatteryAnalyzer.max_ion_insertion"><code class="docutils literal notranslate"><span class="pre">BatteryAnalyzer.max_ion_insertion</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="pymatgen.apps.battery.html#pymatgen.apps.battery.analyzer.BatteryAnalyzer.max_ion_removal"><code class="docutils literal notranslate"><span class="pre">BatteryAnalyzer.max_ion_removal</span></code></a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="pymatgen.apps.battery.html#pymatgen.apps.battery.analyzer.is_redox_active_intercalation"><code class="docutils literal notranslate"><span class="pre">is_redox_active_intercalation()</span></code></a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="pymatgen.apps.battery.html#module-pymatgen.apps.battery.battery_abc">pymatgen.apps.battery.battery_abc module</a><ul>
<li class="toctree-l3"><a class="reference internal" href="pymatgen.apps.battery.html#pymatgen.apps.battery.battery_abc.AbstractElectrode"><code class="docutils literal notranslate"><span class="pre">AbstractElectrode</span></code></a><ul>
<li class="toctree-l4"><a class="reference internal" href="pymatgen.apps.battery.html#pymatgen.apps.battery.battery_abc.AbstractElectrode.voltage_pairs"><code class="docutils literal notranslate"><span class="pre">AbstractElectrode.voltage_pairs</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="pymatgen.apps.battery.html#pymatgen.apps.battery.battery_abc.AbstractElectrode.working_ion"><code class="docutils literal notranslate"><span class="pre">AbstractElectrode.working_ion</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="pymatgen.apps.battery.html#pymatgen.apps.battery.battery_abc.AbstractElectrode.working_ion_entry"><code class="docutils literal notranslate"><span class="pre">AbstractElectrode.working_ion_entry</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="pymatgen.apps.battery.html#pymatgen.apps.battery.battery_abc.AbstractElectrode.framework_formula"><code class="docutils literal notranslate"><span class="pre">AbstractElectrode.framework_formula</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="pymatgen.apps.battery.html#pymatgen.apps.battery.battery_abc.AbstractElectrode.framework"><code class="docutils literal notranslate"><span class="pre">AbstractElectrode.framework</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="pymatgen.apps.battery.html#id0"><code class="docutils literal notranslate"><span class="pre">AbstractElectrode.framework_formula</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="pymatgen.apps.battery.html#pymatgen.apps.battery.battery_abc.AbstractElectrode.get_average_voltage"><code class="docutils literal notranslate"><span class="pre">AbstractElectrode.get_average_voltage()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="pymatgen.apps.battery.html#pymatgen.apps.battery.battery_abc.AbstractElectrode.get_capacity_grav"><code class="docutils literal notranslate"><span class="pre">AbstractElectrode.get_capacity_grav()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="pymatgen.apps.battery.html#pymatgen.apps.battery.battery_abc.AbstractElectrode.get_capacity_vol"><code class="docutils literal notranslate"><span class="pre">AbstractElectrode.get_capacity_vol()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="pymatgen.apps.battery.html#pymatgen.apps.battery.battery_abc.AbstractElectrode.get_energy_density"><code class="docutils literal notranslate"><span class="pre">AbstractElectrode.get_energy_density()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="pymatgen.apps.battery.html#pymatgen.apps.battery.battery_abc.AbstractElectrode.get_specific_energy"><code class="docutils literal notranslate"><span class="pre">AbstractElectrode.get_specific_energy()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="pymatgen.apps.battery.html#pymatgen.apps.battery.battery_abc.AbstractElectrode.get_sub_electrodes"><code class="docutils literal notranslate"><span class="pre">AbstractElectrode.get_sub_electrodes()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="pymatgen.apps.battery.html#pymatgen.apps.battery.battery_abc.AbstractElectrode.get_summary_dict"><code class="docutils literal notranslate"><span class="pre">AbstractElectrode.get_summary_dict()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="pymatgen.apps.battery.html#pymatgen.apps.battery.battery_abc.AbstractElectrode.max_delta_volume"><code class="docutils literal notranslate"><span class="pre">AbstractElectrode.max_delta_volume</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="pymatgen.apps.battery.html#pymatgen.apps.battery.battery_abc.AbstractElectrode.max_voltage"><code class="docutils literal notranslate"><span class="pre">AbstractElectrode.max_voltage</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="pymatgen.apps.battery.html#pymatgen.apps.battery.battery_abc.AbstractElectrode.max_voltage_step"><code class="docutils literal notranslate"><span class="pre">AbstractElectrode.max_voltage_step</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="pymatgen.apps.battery.html#pymatgen.apps.battery.battery_abc.AbstractElectrode.min_voltage"><code class="docutils literal notranslate"><span class="pre">AbstractElectrode.min_voltage</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="pymatgen.apps.battery.html#pymatgen.apps.battery.battery_abc.AbstractElectrode.normalization_mass"><code class="docutils literal notranslate"><span class="pre">AbstractElectrode.normalization_mass</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="pymatgen.apps.battery.html#pymatgen.apps.battery.battery_abc.AbstractElectrode.normalization_volume"><code class="docutils literal notranslate"><span class="pre">AbstractElectrode.normalization_volume</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="pymatgen.apps.battery.html#pymatgen.apps.battery.battery_abc.AbstractElectrode.num_steps"><code class="docutils literal notranslate"><span class="pre">AbstractElectrode.num_steps</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="pymatgen.apps.battery.html#id1"><code class="docutils literal notranslate"><span class="pre">AbstractElectrode.voltage_pairs</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="pymatgen.apps.battery.html#id2"><code class="docutils literal notranslate"><span class="pre">AbstractElectrode.working_ion</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="pymatgen.apps.battery.html#id3"><code class="docutils literal notranslate"><span class="pre">AbstractElectrode.working_ion_entry</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="pymatgen.apps.battery.html#pymatgen.apps.battery.battery_abc.AbstractElectrode.x_charge"><code class="docutils literal notranslate"><span class="pre">AbstractElectrode.x_charge</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="pymatgen.apps.battery.html#pymatgen.apps.battery.battery_abc.AbstractElectrode.x_discharge"><code class="docutils literal notranslate"><span class="pre">AbstractElectrode.x_discharge</span></code></a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="pymatgen.apps.battery.html#pymatgen.apps.battery.battery_abc.AbstractVoltagePair"><code class="docutils literal notranslate"><span class="pre">AbstractVoltagePair</span></code></a><ul>
<li class="toctree-l4"><a class="reference internal" href="pymatgen.apps.battery.html#pymatgen.apps.battery.battery_abc.AbstractVoltagePair.voltage"><code class="docutils literal notranslate"><span class="pre">AbstractVoltagePair.voltage</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="pymatgen.apps.battery.html#pymatgen.apps.battery.battery_abc.AbstractVoltagePair.mAh"><code class="docutils literal notranslate"><span class="pre">AbstractVoltagePair.mAh</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="pymatgen.apps.battery.html#pymatgen.apps.battery.battery_abc.AbstractVoltagePair.mass_charge"><code class="docutils literal notranslate"><span class="pre">AbstractVoltagePair.mass_charge</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="pymatgen.apps.battery.html#pymatgen.apps.battery.battery_abc.AbstractVoltagePair.mass_discharge"><code class="docutils literal notranslate"><span class="pre">AbstractVoltagePair.mass_discharge</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="pymatgen.apps.battery.html#pymatgen.apps.battery.battery_abc.AbstractVoltagePair.vol_charge"><code class="docutils literal notranslate"><span class="pre">AbstractVoltagePair.vol_charge</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="pymatgen.apps.battery.html#pymatgen.apps.battery.battery_abc.AbstractVoltagePair.vol_discharge"><code class="docutils literal notranslate"><span class="pre">AbstractVoltagePair.vol_discharge</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="pymatgen.apps.battery.html#pymatgen.apps.battery.battery_abc.AbstractVoltagePair.frac_charge"><code class="docutils literal notranslate"><span class="pre">AbstractVoltagePair.frac_charge</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="pymatgen.apps.battery.html#pymatgen.apps.battery.battery_abc.AbstractVoltagePair.frac_discharge"><code class="docutils literal notranslate"><span class="pre">AbstractVoltagePair.frac_discharge</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="pymatgen.apps.battery.html#pymatgen.apps.battery.battery_abc.AbstractVoltagePair.working_ion_entry"><code class="docutils literal notranslate"><span class="pre">AbstractVoltagePair.working_ion_entry</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="pymatgen.apps.battery.html#pymatgen.apps.battery.battery_abc.AbstractVoltagePair.framework_formula"><code class="docutils literal notranslate"><span class="pre">AbstractVoltagePair.framework_formula</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="pymatgen.apps.battery.html#id4"><code class="docutils literal notranslate"><span class="pre">AbstractVoltagePair.frac_charge</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="pymatgen.apps.battery.html#id5"><code class="docutils literal notranslate"><span class="pre">AbstractVoltagePair.frac_discharge</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="pymatgen.apps.battery.html#pymatgen.apps.battery.battery_abc.AbstractVoltagePair.framework"><code class="docutils literal notranslate"><span class="pre">AbstractVoltagePair.framework</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="pymatgen.apps.battery.html#id6"><code class="docutils literal notranslate"><span class="pre">AbstractVoltagePair.framework_formula</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="pymatgen.apps.battery.html#id7"><code class="docutils literal notranslate"><span class="pre">AbstractVoltagePair.mAh</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="pymatgen.apps.battery.html#id8"><code class="docutils literal notranslate"><span class="pre">AbstractVoltagePair.mass_charge</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="pymatgen.apps.battery.html#id9"><code class="docutils literal notranslate"><span class="pre">AbstractVoltagePair.mass_discharge</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="pymatgen.apps.battery.html#id10"><code class="docutils literal notranslate"><span class="pre">AbstractVoltagePair.vol_charge</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="pymatgen.apps.battery.html#id11"><code class="docutils literal notranslate"><span class="pre">AbstractVoltagePair.vol_discharge</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="pymatgen.apps.battery.html#id12"><code class="docutils literal notranslate"><span class="pre">AbstractVoltagePair.voltage</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="pymatgen.apps.battery.html#pymatgen.apps.battery.battery_abc.AbstractVoltagePair.working_ion"><code class="docutils literal notranslate"><span class="pre">AbstractVoltagePair.working_ion</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="pymatgen.apps.battery.html#id13"><code class="docutils literal notranslate"><span class="pre">AbstractVoltagePair.working_ion_entry</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="pymatgen.apps.battery.html#pymatgen.apps.battery.battery_abc.AbstractVoltagePair.x_charge"><code class="docutils literal notranslate"><span class="pre">AbstractVoltagePair.x_charge</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="pymatgen.apps.battery.html#pymatgen.apps.battery.battery_abc.AbstractVoltagePair.x_discharge"><code class="docutils literal notranslate"><span class="pre">AbstractVoltagePair.x_discharge</span></code></a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="pymatgen.apps.battery.html#module-pymatgen.apps.battery.conversion_battery">pymatgen.apps.battery.conversion_battery module</a><ul>
<li class="toctree-l3"><a class="reference internal" href="pymatgen.apps.battery.html#pymatgen.apps.battery.conversion_battery.ConversionElectrode"><code class="docutils literal notranslate"><span class="pre">ConversionElectrode</span></code></a><ul>
<li class="toctree-l4"><a class="reference internal" href="pymatgen.apps.battery.html#pymatgen.apps.battery.conversion_battery.ConversionElectrode.from_composition_and_entries"><code class="docutils literal notranslate"><span class="pre">ConversionElectrode.from_composition_and_entries()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="pymatgen.apps.battery.html#pymatgen.apps.battery.conversion_battery.ConversionElectrode.from_composition_and_pd"><code class="docutils literal notranslate"><span class="pre">ConversionElectrode.from_composition_and_pd()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="pymatgen.apps.battery.html#pymatgen.apps.battery.conversion_battery.ConversionElectrode.get_sub_electrodes"><code class="docutils literal notranslate"><span class="pre">ConversionElectrode.get_sub_electrodes()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="pymatgen.apps.battery.html#pymatgen.apps.battery.conversion_battery.ConversionElectrode.get_summary_dict"><code class="docutils literal notranslate"><span class="pre">ConversionElectrode.get_summary_dict()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="pymatgen.apps.battery.html#pymatgen.apps.battery.conversion_battery.ConversionElectrode.initial_comp"><code class="docutils literal notranslate"><span class="pre">ConversionElectrode.initial_comp</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="pymatgen.apps.battery.html#pymatgen.apps.battery.conversion_battery.ConversionElectrode.initial_comp_formula"><code class="docutils literal notranslate"><span class="pre">ConversionElectrode.initial_comp_formula</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="pymatgen.apps.battery.html#pymatgen.apps.battery.conversion_battery.ConversionElectrode.is_super_electrode"><code class="docutils literal notranslate"><span class="pre">ConversionElectrode.is_super_electrode()</span></code></a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="pymatgen.apps.battery.html#pymatgen.apps.battery.conversion_battery.ConversionVoltagePair"><code class="docutils literal notranslate"><span class="pre">ConversionVoltagePair</span></code></a><ul>
<li class="toctree-l4"><a class="reference internal" href="pymatgen.apps.battery.html#pymatgen.apps.battery.conversion_battery.ConversionVoltagePair.rxn"><code class="docutils literal notranslate"><span class="pre">ConversionVoltagePair.rxn</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="pymatgen.apps.battery.html#pymatgen.apps.battery.conversion_battery.ConversionVoltagePair.voltage"><code class="docutils literal notranslate"><span class="pre">ConversionVoltagePair.voltage</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="pymatgen.apps.battery.html#pymatgen.apps.battery.conversion_battery.ConversionVoltagePair.mAh"><code class="docutils literal notranslate"><span class="pre">ConversionVoltagePair.mAh</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="pymatgen.apps.battery.html#pymatgen.apps.battery.conversion_battery.ConversionVoltagePair.vol_charge"><code class="docutils literal notranslate"><span class="pre">ConversionVoltagePair.vol_charge</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="pymatgen.apps.battery.html#pymatgen.apps.battery.conversion_battery.ConversionVoltagePair.vol_discharge"><code class="docutils literal notranslate"><span class="pre">ConversionVoltagePair.vol_discharge</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="pymatgen.apps.battery.html#pymatgen.apps.battery.conversion_battery.ConversionVoltagePair.mass_charge"><code class="docutils literal notranslate"><span class="pre">ConversionVoltagePair.mass_charge</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="pymatgen.apps.battery.html#pymatgen.apps.battery.conversion_battery.ConversionVoltagePair.mass_discharge"><code class="docutils literal notranslate"><span class="pre">ConversionVoltagePair.mass_discharge</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="pymatgen.apps.battery.html#pymatgen.apps.battery.conversion_battery.ConversionVoltagePair.frac_charge"><code class="docutils literal notranslate"><span class="pre">ConversionVoltagePair.frac_charge</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="pymatgen.apps.battery.html#pymatgen.apps.battery.conversion_battery.ConversionVoltagePair.frac_discharge"><code class="docutils literal notranslate"><span class="pre">ConversionVoltagePair.frac_discharge</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="pymatgen.apps.battery.html#pymatgen.apps.battery.conversion_battery.ConversionVoltagePair.entries_charge"><code class="docutils literal notranslate"><span class="pre">ConversionVoltagePair.entries_charge</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="pymatgen.apps.battery.html#pymatgen.apps.battery.conversion_battery.ConversionVoltagePair.entries_discharge"><code class="docutils literal notranslate"><span class="pre">ConversionVoltagePair.entries_discharge</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="pymatgen.apps.battery.html#pymatgen.apps.battery.conversion_battery.ConversionVoltagePair.working_ion_entry"><code class="docutils literal notranslate"><span class="pre">ConversionVoltagePair.working_ion_entry</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="pymatgen.apps.battery.html#id14"><code class="docutils literal notranslate"><span class="pre">ConversionVoltagePair.entries_charge</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="pymatgen.apps.battery.html#id15"><code class="docutils literal notranslate"><span class="pre">ConversionVoltagePair.entries_discharge</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="pymatgen.apps.battery.html#pymatgen.apps.battery.conversion_battery.ConversionVoltagePair.from_steps"><code class="docutils literal notranslate"><span class="pre">ConversionVoltagePair.from_steps()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="pymatgen.apps.battery.html#id16"><code class="docutils literal notranslate"><span class="pre">ConversionVoltagePair.rxn</span></code></a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="pymatgen.apps.battery.html#module-pymatgen.apps.battery.insertion_battery">pymatgen.apps.battery.insertion_battery module</a><ul>
<li class="toctree-l3"><a class="reference internal" href="pymatgen.apps.battery.html#pymatgen.apps.battery.insertion_battery.InsertionElectrode"><code class="docutils literal notranslate"><span class="pre">InsertionElectrode</span></code></a><ul>
<li class="toctree-l4"><a class="reference internal" href="pymatgen.apps.battery.html#pymatgen.apps.battery.insertion_battery.InsertionElectrode.as_dict_legacy"><code class="docutils literal notranslate"><span class="pre">InsertionElectrode.as_dict_legacy()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="pymatgen.apps.battery.html#pymatgen.apps.battery.insertion_battery.InsertionElectrode.from_dict_legacy"><code class="docutils literal notranslate"><span class="pre">InsertionElectrode.from_dict_legacy()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="pymatgen.apps.battery.html#pymatgen.apps.battery.insertion_battery.InsertionElectrode.from_entries"><code class="docutils literal notranslate"><span class="pre">InsertionElectrode.from_entries()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="pymatgen.apps.battery.html#pymatgen.apps.battery.insertion_battery.InsertionElectrode.fully_charged_entry"><code class="docutils literal notranslate"><span class="pre">InsertionElectrode.fully_charged_entry</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="pymatgen.apps.battery.html#pymatgen.apps.battery.insertion_battery.InsertionElectrode.fully_discharged_entry"><code class="docutils literal notranslate"><span class="pre">InsertionElectrode.fully_discharged_entry</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="pymatgen.apps.battery.html#pymatgen.apps.battery.insertion_battery.InsertionElectrode.get_all_entries"><code class="docutils literal notranslate"><span class="pre">InsertionElectrode.get_all_entries()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="pymatgen.apps.battery.html#pymatgen.apps.battery.insertion_battery.InsertionElectrode.get_max_instability"><code class="docutils literal notranslate"><span class="pre">InsertionElectrode.get_max_instability()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="pymatgen.apps.battery.html#pymatgen.apps.battery.insertion_battery.InsertionElectrode.get_max_muO2"><code class="docutils literal notranslate"><span class="pre">InsertionElectrode.get_max_muO2()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="pymatgen.apps.battery.html#pymatgen.apps.battery.insertion_battery.InsertionElectrode.get_min_instability"><code class="docutils literal notranslate"><span class="pre">InsertionElectrode.get_min_instability()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="pymatgen.apps.battery.html#pymatgen.apps.battery.insertion_battery.InsertionElectrode.get_min_muO2"><code class="docutils literal notranslate"><span class="pre">InsertionElectrode.get_min_muO2()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="pymatgen.apps.battery.html#pymatgen.apps.battery.insertion_battery.InsertionElectrode.get_stable_entries"><code class="docutils literal notranslate"><span class="pre">InsertionElectrode.get_stable_entries()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="pymatgen.apps.battery.html#pymatgen.apps.battery.insertion_battery.InsertionElectrode.get_sub_electrodes"><code class="docutils literal notranslate"><span class="pre">InsertionElectrode.get_sub_electrodes()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="pymatgen.apps.battery.html#pymatgen.apps.battery.insertion_battery.InsertionElectrode.get_summary_dict"><code class="docutils literal notranslate"><span class="pre">InsertionElectrode.get_summary_dict()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="pymatgen.apps.battery.html#pymatgen.apps.battery.insertion_battery.InsertionElectrode.get_unstable_entries"><code class="docutils literal notranslate"><span class="pre">InsertionElectrode.get_unstable_entries()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="pymatgen.apps.battery.html#pymatgen.apps.battery.insertion_battery.InsertionElectrode.stable_entries"><code class="docutils literal notranslate"><span class="pre">InsertionElectrode.stable_entries</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="pymatgen.apps.battery.html#pymatgen.apps.battery.insertion_battery.InsertionElectrode.unstable_entries"><code class="docutils literal notranslate"><span class="pre">InsertionElectrode.unstable_entries</span></code></a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="pymatgen.apps.battery.html#pymatgen.apps.battery.insertion_battery.InsertionVoltagePair"><code class="docutils literal notranslate"><span class="pre">InsertionVoltagePair</span></code></a><ul>
<li class="toctree-l4"><a class="reference internal" href="pymatgen.apps.battery.html#pymatgen.apps.battery.insertion_battery.InsertionVoltagePair.entry_charge"><code class="docutils literal notranslate"><span class="pre">InsertionVoltagePair.entry_charge</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="pymatgen.apps.battery.html#pymatgen.apps.battery.insertion_battery.InsertionVoltagePair.entry_discharge"><code class="docutils literal notranslate"><span class="pre">InsertionVoltagePair.entry_discharge</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="pymatgen.apps.battery.html#pymatgen.apps.battery.insertion_battery.InsertionVoltagePair.from_entries"><code class="docutils literal notranslate"><span class="pre">InsertionVoltagePair.from_entries()</span></code></a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="pymatgen.apps.battery.html#module-pymatgen.apps.battery.plotter">pymatgen.apps.battery.plotter module</a><ul>
<li class="toctree-l3"><a class="reference internal" href="pymatgen.apps.battery.html#pymatgen.apps.battery.plotter.VoltageProfilePlotter"><code class="docutils literal notranslate"><span class="pre">VoltageProfilePlotter</span></code></a><ul>
<li class="toctree-l4"><a class="reference internal" href="pymatgen.apps.battery.html#pymatgen.apps.battery.plotter.VoltageProfilePlotter.add_electrode"><code class="docutils literal notranslate"><span class="pre">VoltageProfilePlotter.add_electrode()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="pymatgen.apps.battery.html#pymatgen.apps.battery.plotter.VoltageProfilePlotter.get_plot"><code class="docutils literal notranslate"><span class="pre">VoltageProfilePlotter.get_plot()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="pymatgen.apps.battery.html#pymatgen.apps.battery.plotter.VoltageProfilePlotter.get_plot_data"><code class="docutils literal notranslate"><span class="pre">VoltageProfilePlotter.get_plot_data()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="pymatgen.apps.battery.html#pymatgen.apps.battery.plotter.VoltageProfilePlotter.get_plotly_figure"><code class="docutils literal notranslate"><span class="pre">VoltageProfilePlotter.get_plotly_figure()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="pymatgen.apps.battery.html#pymatgen.apps.battery.plotter.VoltageProfilePlotter.save"><code class="docutils literal notranslate"><span class="pre">VoltageProfilePlotter.save()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="pymatgen.apps.battery.html#pymatgen.apps.battery.plotter.VoltageProfilePlotter.show"><code class="docutils literal notranslate"><span class="pre">VoltageProfilePlotter.show()</span></code></a></li>
</ul>
</li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="pymatgen.apps.borg.html">pymatgen.apps.borg package</a><ul>
<li class="toctree-l2"><a class="reference internal" href="pymatgen.apps.borg.html#submodules">Submodules</a></li>
<li class="toctree-l2"><a class="reference internal" href="pymatgen.apps.borg.html#module-pymatgen.apps.borg.hive">pymatgen.apps.borg.hive module</a><ul>
<li class="toctree-l3"><a class="reference internal" href="pymatgen.apps.borg.html#pymatgen.apps.borg.hive.AbstractDrone"><code class="docutils literal notranslate"><span class="pre">AbstractDrone</span></code></a><ul>
<li class="toctree-l4"><a class="reference internal" href="pymatgen.apps.borg.html#pymatgen.apps.borg.hive.AbstractDrone.assimilate"><code class="docutils literal notranslate"><span class="pre">AbstractDrone.assimilate()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="pymatgen.apps.borg.html#pymatgen.apps.borg.hive.AbstractDrone.get_valid_paths"><code class="docutils literal notranslate"><span class="pre">AbstractDrone.get_valid_paths()</span></code></a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="pymatgen.apps.borg.html#pymatgen.apps.borg.hive.GaussianToComputedEntryDrone"><code class="docutils literal notranslate"><span class="pre">GaussianToComputedEntryDrone</span></code></a><ul>
<li class="toctree-l4"><a class="reference internal" href="pymatgen.apps.borg.html#pymatgen.apps.borg.hive.GaussianToComputedEntryDrone.as_dict"><code class="docutils literal notranslate"><span class="pre">GaussianToComputedEntryDrone.as_dict()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="pymatgen.apps.borg.html#pymatgen.apps.borg.hive.GaussianToComputedEntryDrone.assimilate"><code class="docutils literal notranslate"><span class="pre">GaussianToComputedEntryDrone.assimilate()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="pymatgen.apps.borg.html#pymatgen.apps.borg.hive.GaussianToComputedEntryDrone.from_dict"><code class="docutils literal notranslate"><span class="pre">GaussianToComputedEntryDrone.from_dict()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="pymatgen.apps.borg.html#pymatgen.apps.borg.hive.GaussianToComputedEntryDrone.get_valid_paths"><code class="docutils literal notranslate"><span class="pre">GaussianToComputedEntryDrone.get_valid_paths()</span></code></a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="pymatgen.apps.borg.html#pymatgen.apps.borg.hive.SimpleVaspToComputedEntryDrone"><code class="docutils literal notranslate"><span class="pre">SimpleVaspToComputedEntryDrone</span></code></a><ul>
<li class="toctree-l4"><a class="reference internal" href="pymatgen.apps.borg.html#pymatgen.apps.borg.hive.SimpleVaspToComputedEntryDrone.as_dict"><code class="docutils literal notranslate"><span class="pre">SimpleVaspToComputedEntryDrone.as_dict()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="pymatgen.apps.borg.html#pymatgen.apps.borg.hive.SimpleVaspToComputedEntryDrone.assimilate"><code class="docutils literal notranslate"><span class="pre">SimpleVaspToComputedEntryDrone.assimilate()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="pymatgen.apps.borg.html#pymatgen.apps.borg.hive.SimpleVaspToComputedEntryDrone.from_dict"><code class="docutils literal notranslate"><span class="pre">SimpleVaspToComputedEntryDrone.from_dict()</span></code></a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="pymatgen.apps.borg.html#pymatgen.apps.borg.hive.VaspToComputedEntryDrone"><code class="docutils literal notranslate"><span class="pre">VaspToComputedEntryDrone</span></code></a><ul>
<li class="toctree-l4"><a class="reference internal" href="pymatgen.apps.borg.html#pymatgen.apps.borg.hive.VaspToComputedEntryDrone.as_dict"><code class="docutils literal notranslate"><span class="pre">VaspToComputedEntryDrone.as_dict()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="pymatgen.apps.borg.html#pymatgen.apps.borg.hive.VaspToComputedEntryDrone.assimilate"><code class="docutils literal notranslate"><span class="pre">VaspToComputedEntryDrone.assimilate()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="pymatgen.apps.borg.html#pymatgen.apps.borg.hive.VaspToComputedEntryDrone.from_dict"><code class="docutils literal notranslate"><span class="pre">VaspToComputedEntryDrone.from_dict()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="pymatgen.apps.borg.html#pymatgen.apps.borg.hive.VaspToComputedEntryDrone.get_valid_paths"><code class="docutils literal notranslate"><span class="pre">VaspToComputedEntryDrone.get_valid_paths()</span></code></a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="pymatgen.apps.borg.html#module-pymatgen.apps.borg.queen">pymatgen.apps.borg.queen module</a><ul>
<li class="toctree-l3"><a class="reference internal" href="pymatgen.apps.borg.html#pymatgen.apps.borg.queen.BorgQueen"><code class="docutils literal notranslate"><span class="pre">BorgQueen</span></code></a><ul>
<li class="toctree-l4"><a class="reference internal" href="pymatgen.apps.borg.html#pymatgen.apps.borg.queen.BorgQueen.get_data"><code class="docutils literal notranslate"><span class="pre">BorgQueen.get_data()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="pymatgen.apps.borg.html#pymatgen.apps.borg.queen.BorgQueen.load_data"><code class="docutils literal notranslate"><span class="pre">BorgQueen.load_data()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="pymatgen.apps.borg.html#pymatgen.apps.borg.queen.BorgQueen.parallel_assimilate"><code class="docutils literal notranslate"><span class="pre">BorgQueen.parallel_assimilate()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="pymatgen.apps.borg.html#pymatgen.apps.borg.queen.BorgQueen.save_data"><code class="docutils literal notranslate"><span class="pre">BorgQueen.save_data()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="pymatgen.apps.borg.html#pymatgen.apps.borg.queen.BorgQueen.serial_assimilate"><code class="docutils literal notranslate"><span class="pre">BorgQueen.serial_assimilate()</span></code></a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="pymatgen.apps.borg.html#pymatgen.apps.borg.queen.order_assimilation"><code class="docutils literal notranslate"><span class="pre">order_assimilation()</span></code></a></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</section>
</section>


           </div>
          </div>
          <footer>

  <hr/>

  <div role="contentinfo">
    <p>&#169; Copyright 2011, Pymatgen Development Team.</p>
  </div>

  Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
    <a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
    provided by <a href="https://readthedocs.org">Read the Docs</a>.
   

</footer>
        </div>
      </div>
    </section>
  </div>
  <script>
      jQuery(function () {
          SphinxRtdTheme.Navigation.enable(true);
      });
  </script> 

</body>
</html>
